<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/quantum_spinlock.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d5/d5d/quantum__spinlock_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_spinlock.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef BLOOMBERG_QUANTUM_SPINLOCK_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define BLOOMBERG_QUANTUM_SPINLOCK_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;atomic&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;mutex&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">//                                 class SpinLock</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html">   31</a></span>&#160;<span class="comment"></span><span class="keyword">class </span><a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a7b02a9641f8dc0fd1ed49da0727544bd">   34</a></span>&#160;    <span class="keyword">using</span> <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a7b02a9641f8dc0fd1ed49da0727544bd">TryToLock</a> = std::try_to_lock_t;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    </div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ae5c44ace294ef6f289c41b1eb5944db1">SpinLock</a>();</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    </div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ae5c44ace294ef6f289c41b1eb5944db1">SpinLock</a>(<span class="keyword">const</span> <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    </div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ae5c44ace294ef6f289c41b1eb5944db1">SpinLock</a>(<a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    </div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp; <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ad99101ec9f150115298b8f2eeed53e24">operator=</a>(<span class="keyword">const</span> <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    </div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp; <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ad99101ec9f150115298b8f2eeed53e24">operator=</a>(<a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp;&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    </div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a09b87ac342dc40720bb3161758b97ccd">lock</a>();</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    </div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a701716227a6034d24a18f1a30ee9c6ce">tryLock</a>();</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    </div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a530d6ca8dc3002ef5e9b90d8743cb10f">unlock</a>();</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    </div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="comment">//                                      class SpinLock::Guard</span></div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html">   71</a></span>&#160;<span class="comment"></span>    <span class="keyword">class </span><a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html">Guard</a></div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    {</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keyword">public</span>:</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;        <span class="keyword">explicit</span> <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a8b2e3ce6f8e4eb156bda6719c5ba3b0f">Guard</a>(<a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp; <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a278cca1b5a3397053de918f389d584c9">lock</a>);</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        </div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;        <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a8b2e3ce6f8e4eb156bda6719c5ba3b0f">Guard</a>(<a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp; <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a278cca1b5a3397053de918f389d584c9">lock</a>, <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a7b02a9641f8dc0fd1ed49da0727544bd">SpinLock::TryToLock</a>);</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;        </div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#ad5a1d7a7122a97faf3bb5bcb011739db">~Guard</a>();</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;        </div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a278cca1b5a3397053de918f389d584c9">lock</a>();</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;        </div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#adc8b8e898391621b578adde8a1bd81be">tryLock</a>();</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        </div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#ad0ee23a238116199267176f91d1a30f0">ownsLock</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keyword">private</span>:</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp;   _spinlock;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;        <span class="keywordtype">bool</span>        _ownsLock;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    };</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    </div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    <span class="comment">//                                 class SpinLock::ReverseGuard</span></div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    <span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html">  110</a></span>&#160;<span class="comment"></span>    <span class="keyword">class </span><a class="code" href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html">ReverseGuard</a></div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;    {</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    <span class="keyword">public</span>:</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        <span class="keyword">explicit</span> <a class="code" href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html#a5203ffec8482c68e9e40535d938de5ce">ReverseGuard</a>(<a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp; <a class="code" href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a09b87ac342dc40720bb3161758b97ccd">lock</a>);</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;        </div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        <a class="code" href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html#aee249cfe88d1f1ff5b94e522b545dd03">~ReverseGuard</a>();</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        <a class="code" href="../../de/df4/namespaceSpinLock.html">SpinLock</a>&amp;   _spinlock;</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    };</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    </div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    std::atomic_flag    _flag;</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;};</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;}}</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="preprocessor">#include &lt;quantum/impl/quantum_spinlock_impl.h&gt;</span></div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#endif //BLOOMBERG_QUANTUM_SPINLOCK_H</span></div><div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1Guard_html_a8b2e3ce6f8e4eb156bda6719c5ba3b0f"><div class="ttname"><a href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a8b2e3ce6f8e4eb156bda6719c5ba3b0f">Bloomberg::quantum::SpinLock::Guard::Guard</a></div><div class="ttdeci">Guard(SpinLock &amp;lock)</div><div class="ttdoc">Construct this object and lock the passed-in spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:49</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1Guard_html"><div class="ttname"><a href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html">Bloomberg::quantum::SpinLock::Guard</a></div><div class="ttdef"><b>Definition:</b> quantum_spinlock.h:71</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_html_a09b87ac342dc40720bb3161758b97ccd"><div class="ttname"><a href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a09b87ac342dc40720bb3161758b97ccd">Bloomberg::quantum::SpinLock::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">Locks this object.</div></div>
<div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1Guard_html_ad5a1d7a7122a97faf3bb5bcb011739db"><div class="ttname"><a href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#ad5a1d7a7122a97faf3bb5bcb011739db">Bloomberg::quantum::SpinLock::Guard::~Guard</a></div><div class="ttdeci">~Guard()</div><div class="ttdoc">Destroy this object and unlock the underlying spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:64</div></div>
<div class="ttc" id="namespaceSpinLock_html"><div class="ttname"><a href="../../de/df4/namespaceSpinLock.html">SpinLock</a></div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard_html_aee249cfe88d1f1ff5b94e522b545dd03"><div class="ttname"><a href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html#aee249cfe88d1f1ff5b94e522b545dd03">Bloomberg::quantum::SpinLock::ReverseGuard::~ReverseGuard</a></div><div class="ttdeci">~ReverseGuard()</div><div class="ttdoc">Acquire the underlying spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:102</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_html_ae5c44ace294ef6f289c41b1eb5944db1"><div class="ttname"><a href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ae5c44ace294ef6f289c41b1eb5944db1">Bloomberg::quantum::SpinLock::SpinLock</a></div><div class="ttdeci">SpinLock()</div><div class="ttdoc">Constructor. The object is in the unlocked state.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:26</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard_html_a5203ffec8482c68e9e40535d938de5ce"><div class="ttname"><a href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html#a5203ffec8482c68e9e40535d938de5ce">Bloomberg::quantum::SpinLock::ReverseGuard::ReverseGuard</a></div><div class="ttdeci">ReverseGuard(SpinLock &amp;lock)</div><div class="ttdoc">Release the passed-in spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:95</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1Guard_html_adc8b8e898391621b578adde8a1bd81be"><div class="ttname"><a href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#adc8b8e898391621b578adde8a1bd81be">Bloomberg::quantum::SpinLock::Guard::tryLock</a></div><div class="ttdeci">bool tryLock()</div><div class="ttdoc">Try to acquire the underlying spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:72</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard_html"><div class="ttname"><a href="../../dd/d36/classBloomberg_1_1quantum_1_1SpinLock_1_1ReverseGuard.html">Bloomberg::quantum::SpinLock::ReverseGuard</a></div><div class="ttdef"><b>Definition:</b> quantum_spinlock.h:110</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_html_ad99101ec9f150115298b8f2eeed53e24"><div class="ttname"><a href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#ad99101ec9f150115298b8f2eeed53e24">Bloomberg::quantum::SpinLock::operator=</a></div><div class="ttdeci">SpinLock &amp; operator=(const SpinLock &amp;)=delete</div><div class="ttdoc">Copy assignment operator.</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1Guard_html_ad0ee23a238116199267176f91d1a30f0"><div class="ttname"><a href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#ad0ee23a238116199267176f91d1a30f0">Bloomberg::quantum::SpinLock::Guard::ownsLock</a></div><div class="ttdeci">bool ownsLock() const</div><div class="ttdoc">Indicates if this object owns the underlying spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:90</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_html_a7b02a9641f8dc0fd1ed49da0727544bd"><div class="ttname"><a href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a7b02a9641f8dc0fd1ed49da0727544bd">Bloomberg::quantum::SpinLock::TryToLock</a></div><div class="ttdeci">std::try_to_lock_t TryToLock</div><div class="ttdef"><b>Definition:</b> quantum_spinlock.h:34</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_1_1Guard_html_a278cca1b5a3397053de918f389d584c9"><div class="ttname"><a href="../../db/de4/classBloomberg_1_1quantum_1_1SpinLock_1_1Guard.html#a278cca1b5a3397053de918f389d584c9">Bloomberg::quantum::SpinLock::Guard::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">Acquire the underlying spinlock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:81</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_html_a530d6ca8dc3002ef5e9b90d8743cb10f"><div class="ttname"><a href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a530d6ca8dc3002ef5e9b90d8743cb10f">Bloomberg::quantum::SpinLock::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdoc">Unlocks the current object.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:43</div></div>
<div class="ttc" id="classBloomberg_1_1quantum_1_1SpinLock_html_a701716227a6034d24a18f1a30ee9c6ce"><div class="ttname"><a href="../../d1/d05/classBloomberg_1_1quantum_1_1SpinLock.html#a701716227a6034d24a18f1a30ee9c6ce">Bloomberg::quantum::SpinLock::tryLock</a></div><div class="ttdeci">bool tryLock()</div><div class="ttdoc">Attempt to acquire the lock.</div><div class="ttdef"><b>Definition:</b> quantum_spinlock_impl.h:37</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>quantum_spinlock.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
